home *** CD-ROM | disk | FTP | other *** search
/ Ultra Pack / UltraComputing Partner Applications.iso / SunLabs / tclTK / src / tk4.0 / tkImgFmtPPM.c < prev    next >
C/C++ Source or Header  |  1995-06-15  |  10KB  |  389 lines
  1. /*
  2.  * tkImgFmtPPM.c --
  3.  *
  4.  *    A photo image file handler for PPM (Portable PixMap) files.
  5.  *
  6.  * Copyright (c) 1994 The Australian National University.
  7.  * Copyright (c) 1994-1995 Sun Microsystems, Inc.
  8.  *
  9.  * See the file "license.terms" for information on usage and redistribution
  10.  * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  11.  *
  12.  * Author: Paul Mackerras (paulus@cs.anu.edu.au),
  13.  *       Department of Computer Science,
  14.  *       Australian National University.
  15.  */
  16.  
  17. static char sccsid[] = "@(#) tkImgFmtPPM.c 1.7 95/06/14 22:49:55";
  18.  
  19. #include "tkInt.h"
  20. #include "tkPort.h"
  21.  
  22. /*
  23.  * The maximum amount of memory to allocate for data read from the
  24.  * file.  If we need more than this, we do it in pieces.
  25.  */
  26.  
  27. #define MAX_MEMORY    10000        /* don't allocate > 10KB */
  28.  
  29. /*
  30.  * Define PGM and PPM, i.e. gray images and color images.
  31.  */
  32.  
  33. #define PGM 1
  34. #define PPM 2
  35.  
  36. /*
  37.  * The format record for the PPM file format:
  38.  */
  39.  
  40. static int        FileMatchPPM _ANSI_ARGS_((FILE *f, char *fileName,
  41.                 char *formatString, int *widthPtr,
  42.                 int *heightPtr));
  43. static int        FileReadPPM  _ANSI_ARGS_((Tcl_Interp *interp,
  44.                 FILE *f, char *fileName, char *formatString,
  45.                 Tk_PhotoHandle imageHandle, int destX, int destY,
  46.                 int width, int height, int srcX, int srcY));
  47. static int        FileWritePPM _ANSI_ARGS_((Tcl_Interp *interp,
  48.                 char *fileName, char *formatString,
  49.                 Tk_PhotoImageBlock *blockPtr));
  50.  
  51. Tk_PhotoImageFormat tkImgFmtPPM = {
  52.     "PPM",            /* name */
  53.     FileMatchPPM,        /* fileMatchProc */
  54.     NULL,            /* stringMatchProc */
  55.     FileReadPPM,        /* fileReadProc */
  56.     NULL,            /* stringReadProc */
  57.     FileWritePPM,        /* fileWriteProc */
  58.     NULL,            /* stringWriteProc */
  59. };
  60.  
  61. /*
  62.  * Prototypes for local procedures defined in this file:
  63.  */
  64.  
  65. static int        ReadPPMFileHeader _ANSI_ARGS_((FILE *f, int *widthPtr,
  66.                 int *heightPtr));
  67.  
  68. /*
  69.  *----------------------------------------------------------------------
  70.  *
  71.  * FileMatchPPM --
  72.  *
  73.  *    This procedure is invoked by the photo image type to see if
  74.  *    a file contains image data in PPM format.
  75.  *
  76.  * Results:
  77.  *    The return value is >0 if the first characters in file "f" look
  78.  *    like PPM data, and 0 otherwise.
  79.  *
  80.  * Side effects:
  81.  *    The access position in f may change.
  82.  *
  83.  *----------------------------------------------------------------------
  84.  */
  85.  
  86. static int
  87. FileMatchPPM(f, fileName, formatString, widthPtr, heightPtr)
  88.     FILE *f;            /* The image file, open for reading. */
  89.     char *fileName;        /* The name of the image file. */
  90.     char *formatString;        /* User-specified format string, or NULL. */
  91.     int *widthPtr, *heightPtr;    /* The dimensions of the image are
  92.                  * returned here if the file is a valid
  93.                  * raw PPM file. */
  94. {
  95.     return ReadPPMFileHeader(f, widthPtr, heightPtr);
  96. }
  97.  
  98. /*
  99.  *----------------------------------------------------------------------
  100.  *
  101.  * FileReadPPM --
  102.  *
  103.  *    This procedure is called by the photo image type to read
  104.  *    PPM format data from a file and write it into a given
  105.  *    photo image.
  106.  *
  107.  * Results:
  108.  *    A standard TCL completion code.  If TCL_ERROR is returned
  109.  *    then an error message is left in interp->result.
  110.  *
  111.  * Side effects:
  112.  *    The access position in file f is changed, and new data is
  113.  *    added to the image given by imageHandle.
  114.  *
  115.  *----------------------------------------------------------------------
  116.  */
  117.  
  118. static int
  119. FileReadPPM(interp, f, fileName, formatString, imageHandle, destX, destY,
  120.     width, height, srcX, srcY)
  121.     Tcl_Interp *interp;        /* Interpreter to use for reporting errors. */
  122.     FILE *f;            /* The image file, open for reading. */
  123.     char *fileName;        /* The name of the image file. */
  124.     char *formatString;        /* User-specified format string, or NULL. */
  125.     Tk_PhotoHandle imageHandle;    /* The photo image to write into. */
  126.     int destX, destY;        /* Coordinates of top-left pixel in
  127.                  * photo image to be written to. */
  128.     int width, height;        /* Dimensions of block of photo image to
  129.                  * be written to. */
  130.     int srcX, srcY;        /* Coordinates of top-left pixel to be used
  131.                  * in image being read. */
  132. {
  133.     int fileWidth, fileHeight;
  134.     int nLines, nBytes, h, type, count;
  135.     unsigned char *pixelPtr;
  136.     Tk_PhotoImageBlock block;
  137.  
  138.     type = ReadPPMFileHeader(f, &fileWidth, &fileHeight);
  139.     if (type == 0) {
  140.     Tcl_AppendResult(interp, "couldn't read raw PPM header from file \"",
  141.         fileName, "\"", NULL);
  142.     return TCL_ERROR;
  143.     }
  144.     if ((fileWidth <= 0) || (fileHeight <= 0)) {
  145.     Tcl_AppendResult(interp, "PPM image file \"", fileName,
  146.         "\" has dimension(s) <= 0", (char *) NULL);
  147.     return TCL_ERROR;
  148.     }
  149.  
  150.     if ((srcX + width) > fileWidth) {
  151.     width = fileWidth - srcX;
  152.     }
  153.     if ((srcY + height) > fileHeight) {
  154.     height = fileHeight - srcY;
  155.     }
  156.     if ((width <= 0) || (height <= 0)
  157.     || (srcX >= fileWidth) || (srcY >= fileHeight)) {
  158.     return TCL_OK;
  159.     }
  160.  
  161.     if (type == PGM) {
  162.         block.pixelSize = 1;
  163.         block.offset[0] = 0;
  164.     block.offset[1] = 0;
  165.     block.offset[2] = 0;
  166.     }
  167.     else {
  168.         block.pixelSize = 3;
  169.         block.offset[0] = 0;
  170.     block.offset[1] = 1;
  171.     block.offset[2] = 2;
  172.     }
  173.     block.width = width;
  174.     block.pitch = block.pixelSize * fileWidth;
  175.  
  176.     Tk_PhotoExpand(imageHandle, destX + width, destY + height);
  177.  
  178.     if (srcY > 0) {
  179.     fseek(f, (long) (srcY * block.pitch), SEEK_CUR);
  180.     }
  181.  
  182.     nLines = (MAX_MEMORY + block.pitch - 1) / block.pitch;
  183.     if (nLines > height) {
  184.     nLines = height;
  185.     }
  186.     if (nLines <= 0) {
  187.     nLines = 1;
  188.     }
  189.     nBytes = nLines * block.pitch;
  190.     pixelPtr = (unsigned char *) ckalloc((unsigned) nBytes);
  191.     block.pixelPtr = pixelPtr + srcX * block.pixelSize;
  192.  
  193.     for (h = height; h > 0; h -= nLines) {
  194.     if (nLines > h) {
  195.         nLines = h;
  196.         nBytes = nLines * block.pitch;
  197.     }
  198.     count = fread(pixelPtr, 1, (unsigned) nBytes, f);
  199.     if (count != nBytes) {
  200.         Tcl_AppendResult(interp, "error reading PPM image file \"",
  201.             fileName, "\": ",
  202.             feof(f) ? "not enough data" : Tcl_PosixError(interp),
  203.             (char *) NULL);
  204.         ckfree((char *) pixelPtr);
  205.         return TCL_ERROR;
  206.     }
  207.     block.height = nLines;
  208.     Tk_PhotoPutBlock(imageHandle, &block, destX, destY, width, nLines);
  209.     destY += nLines;
  210.     }
  211.  
  212.     ckfree((char *) pixelPtr);
  213.     return TCL_OK;
  214. }
  215.  
  216. /*
  217.  *----------------------------------------------------------------------
  218.  *
  219.  * FileWritePPM --
  220.  *
  221.  *    This procedure is invoked to write image data to a file in PPM
  222.  *    format.
  223.  *
  224.  * Results:
  225.  *    A standard TCL completion code.  If TCL_ERROR is returned
  226.  *    then an error message is left in interp->result.
  227.  *
  228.  * Side effects:
  229.  *    Data is written to the file given by "fileName".
  230.  *
  231.  *----------------------------------------------------------------------
  232.  */
  233.  
  234. static int
  235. FileWritePPM(interp, fileName, formatString, blockPtr)
  236.     Tcl_Interp *interp;
  237.     char *fileName;
  238.     char *formatString;
  239.     Tk_PhotoImageBlock *blockPtr;
  240. {
  241.     FILE *f;
  242.     int w, h;
  243.     int greenOffset, blueOffset, nBytes;
  244.     unsigned char *pixelPtr, *pixLinePtr;
  245.  
  246.     if ((f = fopen(fileName, "wb")) == NULL) {
  247.     Tcl_AppendResult(interp, fileName, ": ", Tcl_PosixError(interp),
  248.         (char *)NULL);
  249.     return TCL_ERROR;
  250.     }
  251.  
  252.     fprintf(f, "P6\n%d %d\n255\n", blockPtr->width, blockPtr->height);
  253.  
  254.     pixLinePtr = blockPtr->pixelPtr + blockPtr->offset[0];
  255.     greenOffset = blockPtr->offset[1] - blockPtr->offset[0];
  256.     blueOffset = blockPtr->offset[2] - blockPtr->offset[0];
  257.  
  258.     if ((greenOffset == 1) && (blueOffset == 2) && (blockPtr->pixelSize == 3)
  259.         && (blockPtr->pitch == (blockPtr->width * 3))) {
  260.     nBytes = blockPtr->height * blockPtr->pitch;
  261.     if (fwrite(pixLinePtr, 1, (unsigned) nBytes, f) != nBytes) {
  262.         goto writeerror;
  263.     }
  264.     } else {
  265.     for (h = blockPtr->height; h > 0; h--) {
  266.         pixelPtr = pixLinePtr;
  267.         for (w = blockPtr->width; w > 0; w--) {
  268.         if ((putc(pixelPtr[0], f) == EOF)
  269.             || (putc(pixelPtr[greenOffset], f) == EOF)
  270.             || (putc(pixelPtr[blueOffset], f) == EOF)) {
  271.             goto writeerror;
  272.         }
  273.         pixelPtr += blockPtr->pixelSize;
  274.         }
  275.         pixLinePtr += blockPtr->pitch;
  276.     }
  277.     }
  278.  
  279.     if (fclose(f) == 0) {
  280.     return TCL_OK;
  281.     }
  282.     f = NULL;
  283.  
  284.  writeerror:
  285.     Tcl_AppendResult(interp, "error writing \"", fileName, "\": ",
  286.         Tcl_PosixError(interp), (char *) NULL);
  287.     if (f != NULL) {
  288.     fclose(f);
  289.     }
  290.     return TCL_ERROR;
  291. }
  292.  
  293. /*
  294.  *----------------------------------------------------------------------
  295.  *
  296.  * ReadPPMFileHeader --
  297.  *
  298.  *    This procedure reads the PPM header from the beginning of a
  299.  *    PPM file and returns the dimensions of the image.
  300.  *
  301.  * Results:
  302.  *    The return value is PGM if file "f" appears to start with
  303.  *    a valid PGM header, PPM if "f" appears to start with a valid
  304.  *      PPM header, and 0 otherwise.  If the header is valid,
  305.  *    then *widthPtr and *heightPtr are modified to hold the
  306.  *    dimensions of the image.
  307.  *
  308.  * Side effects:
  309.  *    The access position in f advances.
  310.  *
  311.  *----------------------------------------------------------------------
  312.  */
  313.  
  314. static int
  315. ReadPPMFileHeader(f, widthPtr, heightPtr)
  316.     FILE *f;            /* Image file to read the header from */
  317.     int *widthPtr, *heightPtr;    /* The dimensions of the image are
  318.                  * returned here. */
  319. {
  320.     int maxPixel;
  321. #define BUFFER_SIZE 1000
  322.     char buffer[BUFFER_SIZE];
  323.     int i, numFields, firstInLine, c;
  324.     int type = 0;
  325.  
  326.     /*
  327.      * Read 4 space-separated fields from the file, ignoring
  328.      * comments (any line that starts with "#").
  329.      */
  330.  
  331.     c = getc(f);
  332.     firstInLine = 1;
  333.     i = 0;
  334.     for (numFields = 0; numFields < 4; numFields++) {
  335.     /*
  336.      * Skip comments and white space.
  337.      */
  338.  
  339.     while (1) {
  340.         while (isspace(UCHAR(c))) {
  341.         firstInLine = (c == '\n');
  342.         c = getc(f);
  343.         }
  344.         if (c != '#') {
  345.         break;
  346.         }
  347.         do {
  348.         c = getc(f);
  349.         } while ((c != EOF) && (c != '\n'));
  350.         firstInLine = 1;
  351.     }
  352.  
  353.     /*
  354.      * Read a field (everything up to the next white space).
  355.      */
  356.  
  357.     while ((c != EOF) && !isspace(UCHAR(c))) {
  358.         if (i < (BUFFER_SIZE-2)) {
  359.         buffer[i]  = c;
  360.         i++;
  361.         }
  362.         c = getc(f);
  363.     }
  364.     buffer[i] = ' ';
  365.     i++;
  366.     firstInLine = 0;
  367.     }
  368.     buffer[i] = 0;
  369.  
  370.     /*
  371.      * Parse the fields, which are: id, width, height, maxPixel.
  372.      */
  373.  
  374.     if (strncmp(buffer, "P6 ", 3) == 0) {
  375.     type = PPM;
  376.     } else if (strncmp(buffer, "P5 ", 3) == 0) {
  377.     type = PGM;
  378.     } else {
  379.     return 0;
  380.     }
  381.     if (sscanf(buffer+3, "%d %d %d", widthPtr, heightPtr, &maxPixel) != 3) {
  382.     return 0;
  383.     }
  384.     if (maxPixel != 255) {
  385.     return 0;
  386.     }
  387.     return type;
  388. }
  389.